fix: clarify markdownlint marker placement in PRD Builder#2098
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2098 +/- ##
==========================================
- Coverage 81.28% 81.17% -0.12%
==========================================
Files 128 127 -1
Lines 18925 18786 -139
Branches 12 12
==========================================
- Hits 15384 15250 -134
+ Misses 3538 3533 -5
Partials 3 3
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
- align PRD and BRD outputs to docs/project-planning - update traceability and disclaimer guidance 📝 - Generated by Copilot
|
@jkim323 I pushed an additional update on this PR to cover the related project-planning guidance that surfaced while fixing the PRD Builder frontmatter issue. What changed:
I also updated the linked issue and PR description to reflect the expanded scope. Validation passed with |
|
Another change made for dt-agent. Moved DT coaching artifacts from Artifacts under |
Eval Execution✅ Status: Passed — no merge-blocking failures (3 advisory assertion failure(s) present)
|
…hve-core into fix/prd-builder-agent
## Description Resolves a batch of documentation drift issues where prose docs and READMEs fell behind code, agent, and path changes from recent PRs. Each fix realigns stale references with the current source of truth: * **BRD/PRD output path move** (PR #2098): updated lifecycle, role, and planning docs to point at `docs/project-planning/` instead of the retired `docs/brds/` and `docs/prds/`. * **Eval CI behavior** (PRs #1834, #1949): documented shared-spec tag-aware run behavior, the missing eval npm commands, and the `mixed` stub mode plus sub-threshold `advisory-fail` status. * **Copyright tooling** (PR #2169): documented the new `CopyrightHeader.psm1` module and the `Test-CopyrightHeaders.ps1` `-Fix` switch and canonical 2026 header format. * **Collection helpers** (PR #1834): documented the new strict-safe maturity vocabulary functions in `CollectionHelpers.psm1`. * **rai-license-posture.instructions.md**: fix dead link and added rai-license-posture instruction conformance stimulus to `instructions.eval.yml` ## Related Issue(s) Closes #2179 Closes #2180 Closes #2181 Closes #2182 Closes #2183 Closes #2187 Closes #2188 Closes #2191 ## Type of Change Select all that apply: **Code & Documentation:** * [ ] Bug fix (non-breaking change fixing an issue) * [ ] New feature (non-breaking change adding functionality) * [ ] Breaking change (fix or feature causing existing functionality to change) * [x] Documentation update **Infrastructure & Configuration:** * [ ] GitHub Actions workflow * [ ] Linting configuration (markdown, PowerShell, etc.) * [ ] Security configuration * [ ] DevContainer configuration * [ ] Dependency update **AI Artifacts:** * [ ] Reviewed contribution with `prompt-builder` agent and addressed all feedback * [ ] Copilot instructions (`.github/instructions/*.instructions.md`) * [ ] Copilot prompt (`.github/prompts/*.prompt.md`) * [ ] Copilot agent (`.github/agents/*.agent.md`) * [ ] Copilot skill (`.github/skills/*/SKILL.md`) * [ ] Copilot hook (`.github/hooks/*/*.json`) * [x] Eval spec added/updated for changed AI artifacts (`evals/`) **Other:** * [ ] Script/automation (`.ps1`, `.sh`, `.py`) * [ ] Other (please describe): ## Testing <!-- Add manual testing descriptions when applicable. Run the documentation validation commands below before merging. --> ## Checklist ### Required Checks * [x] Documentation is updated (if applicable) * [x] Files follow existing naming conventions * [x] Changes are backwards compatible (if applicable) * [ ] Tests added for new functionality (if applicable) (N/A — documentation-only) ### Required Automated Checks The following validation commands must pass before merging: * [x] Markdown linting: `npm run lint:md` * [x] Spell checking: `npm run spell-check` * [x] Frontmatter validation: `npm run lint:frontmatter` * [ ] Skill structure validation: `npm run validate:skills` * [x] Link validation: `npm run lint:md-links` * [ ] PowerShell analysis: `npm run lint:ps` * [ ] Plugin freshness: `npm run plugin:generate` * [ ] Docusaurus tests: `npm run docs:test` ## Security Considerations * [x] This PR does not contain any sensitive or NDA information * [ ] Any new dependencies have been reviewed for security issues (N/A — no dependency changes) * [ ] Security-related scripts follow the principle of least privilege (N/A — no security scripts modified) ## Additional Notes Documentation-only change. #2186 (DT Coach session-path rename) is deliberately excluded from this batch. --------- Co-authored-by: Bill Berry <WilliamBerryiii@users.noreply.github.com>
Pull Request
Description
Clarifies PRD Builder markdown suppression marker placement and aligns the project-planning builder guidance around the consolidated
docs/project-planning/output path.The original issue focused on PRD Builder wording that could place HTML comments before YAML frontmatter. This update keeps the frontmatter opening delimiter on line 1, moves generated suppression comments immediately after the closing frontmatter delimiter, and brings related PRD, BRD, and shared disclaimer instructions into the same project-planning model.
The workflow check failed in model-validation and from investigation seems like the CI workflows fail intermittently when PSGallery has transient outages during Install-Module. Since every workflow installs modules inline without caching or retry, a single gallery hiccup fails the entire job. The changes for this is large so I'll be creating a follow-up PR for this. To mitigate, I fixed the casing.
Changes
docs/project-planning/, preserve valid YAML frontmatter ordering for generated suppression markers, use normalizedphaseSkillsLoadedentries, and ingest upstreamBRD_TO_PRD_HANDOFF_V1coverage context when available.docs/project-planning/, defer frontmatter and section requirements to canonical requirements-author templates, and align traceability language around business goals, FR-to-BG coverage, BG/DD identifiers, and quality gates.applyTopattern to includedocs/project-planning/*alongside the relevant planning and review tracking folders.Related Issue(s)
Fixes #2097
Type of Change
Code & Documentation:
AI Artifacts:
.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md)Testing
npm run lint:mdnpm run lint:frontmatternpm run lint:ai-artifactsSecurity Considerations
Additional Notes
The scope expanded slightly during review to keep PRD Builder, BRD Builder, and the shared disclaimer protocol consistent with the consolidated project-planning document location.